home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / Converters / I2DB.lha / I2DB / I2DB.doc next >
Encoding:
Text File  |  1995-08-17  |  7.8 KB  |  251 lines
  1.                         **********************************************
  2.                         * I2DB - Customizable Aminet Index Converter *
  3.                         **********************************************
  4.  
  5.  
  6. Introduction
  7. ------------
  8.  
  9. A few months ago I uploaded 2 programs to Aminet : I2SB and I2SQL.
  10. Their purpose was to convert an Aminet Index to Superbase (I2SB)
  11. and SQL (I2SQL) import format. But they had many drawbacks : they
  12. were slow, a little bugged and rigid. So if you use them you can
  13. delete them now ! ;-)
  14. Seriousely I am a student so I didn't have the time to correct them.
  15. But I am now on summer hollyday so I have a lot of free time.
  16.  
  17. I2DB is a converter for Aminet Indexes. You'll surely wonder "A converter
  18. to WHICH format ?", won't you ? Well it converts the index to ANY format.
  19. Using external module you can tell I2DB how the data should be written.
  20. As examples I have included two modules : one for Superbase Personal
  21. (1988 version) and one for SQL (you may see now why I said you could erase
  22. I2SB and I2SQL).
  23.  
  24. Moreover I2DB can convert an Aminet CD ROM Index file to the format used
  25. by AST (Aminet Search Tool), a great program written by Arne Meyer. It could
  26. be useful if you want to include the index of your new Aminet CD ROM in the
  27. AST list of the previous ones (I had to do this because the list contains
  28. indexes from CD 2 to CD 6 and I had received my CD 7).
  29.  
  30.  
  31. Features
  32. --------
  33.  
  34. Here comes the list of I2DB's advantages :
  35.  
  36. - Customizable
  37.  
  38. - Fast
  39.  
  40. - AST support
  41.  
  42. - Needless spaces removed
  43.  
  44. - Conflicting caracters remplaced
  45.  
  46. - Automatic detection of fields' size
  47.  
  48. - Calculation of suggested size for fields in the database
  49.  
  50.  
  51. Installation
  52. ------------
  53.  
  54. I think I could say it is very easy. Just put I2DB where you want. :-))
  55.  
  56.  
  57. Required
  58. --------
  59.  
  60. Amiga 4000 T with 68060, 20 MB of free RAM and 2 hard drives of 1 GB ;-)
  61.  
  62. Hey I was joking ! Don't be afraid !
  63.  
  64. Seriousely it should work on every Amiga with Dos.library V37 or newer and
  65. some memory (1 or 2 MB should be sufficient but I'm not sure).
  66. You also need an Aminet Index with 5 fields of any size (network or CD ROM).
  67.  
  68.  
  69. Usage
  70. -----
  71.  
  72. From CLI : Usage : I2DB [ -in <Index name> ] [ -out <Output file name> ]
  73.                         [ -cd <CD number> ] [-ast <CD number>]
  74.                         -cfg <Config file name>
  75.  
  76. * "Index name" is the name of the Index file with its path (example : Work:MyIndex).
  77.   If you don't specify it I2DB will search the file INDEX in its working directory
  78.   and it will stop if it doesn't find it.
  79.  
  80. * "Output file name" is the name of the file which will contain the converted index
  81.   with its path (example : Ram:MessyASCIIFile). If you don't specify it I2DB will
  82.   use standard output (generally the screen).
  83.  
  84. * "CD Number" (for -cd) is an optionnal field which can be added to the conversion.
  85.   If you are converting a CD ROM Index you specify here its number and it will be
  86.   added before the file name of each archive.
  87.  
  88. * "CD Number" (for -ast) will turn on the AST conversion on. The format of -cfg will
  89.   be ignored and the Index will be converted to an AST one. This format features :
  90.  
  91.         - 2 more caracters for the File name
  92.  
  93.         - The + for the long readme is after the size
  94.  
  95.         - The number of the CD is inserted instead of the
  96.           age of the archives.
  97.  
  98. * "Config file name" is the name of the external module used for the conversion.
  99.   It must be present except for an AST conversion.
  100.  
  101. After a conversion (not an AST one) I2DB will display some values which are the maximal
  102. sizes found for each field. You can enter these values for fields' size when creating
  103. your database and it will exactly fit with the converted index.
  104.  
  105.  
  106. Examples
  107. --------
  108.  
  109. * Conversion of the file Work:Tmp/Index7 using the Superbase module :
  110.  
  111.         I2DB -in Work:Tmp/Index7 -cfg Superbase.I2DB
  112.  
  113. * The same but to the file Ram:InputFile :
  114.  
  115.         I2DB -in Work:Tmp/Index7 -out Ram:InputFile -cfg Superbase.I2DB
  116.  
  117. * The same but with the CD number 7
  118.  
  119.         I2DB -in Work:Tmp/Index7 -out Ram:InputFile -cfg Superbase.I2DB -cd 7
  120.  
  121. * Conversion of Work:Tmp/Index7 into AST format
  122.  
  123.         I2DB -in Work:Tmp/Index7 -ast 7
  124.  
  125. NB : "-cd" and "-ast" options are mutually exclusive. If one is found the second
  126.      is ignored.
  127.  
  128.  
  129. External Module
  130. ---------------
  131.  
  132. The modules are built like this :
  133.  
  134. %% <Name> module for I2DB
  135. %% CD Format
  136. <cars>%<cars>%<cars>%<cars>%<cars>%<cars>%<cars>
  137. %% Normal Format
  138. <cars>%<cars>%<cars>%<cars>%<cars>%<cars>
  139. %% Caracters which must be removed
  140. <rcars> <rcars>
  141. %% Caracters which must be inserted instead of the previous ones
  142. <icars> <icars>
  143. %% End of module
  144.  
  145. Now a little explanation :
  146.  
  147. * <Name> will be replaced by the name of the Database program (Ex : Superbase)
  148.  
  149. * <cars> are caracters used by the conversion. The '%' represents the value of the
  150.   field in the index. Let's see that with an example :
  151.   Just imagine that the line is  Klondike.lha  game/think  123K  2  Great Card Game
  152.   If you want your line to be "Klondike.lha","game/think","123K","2","Great Card Game"
  153.   you'll have to enter the following format line : "%","%","%","%","%"
  154.   The format line must be entered twice : the first has another field which is the
  155.   optionnal CD ROM number. In our example it would be  "%","%","%","%","%","%"
  156.  
  157. * <rcars> are caracters which cannot be in the converted file. This could happen
  158.   if there is a conflict between the input format of the database program and a
  159.   caracter in a field. So just type there caracters which should be replaced
  160.   with a space between them.
  161.   Example : To remove " and # the line is " #
  162.  
  163. * <icars> are the caracters which are inserted instead of the removed ones. The
  164.   line format is the same and the positions must be the same two.
  165.  
  166. WARNING !
  167.  
  168.     - The module must have exactly the same format that the included ones.
  169.       Don't remove the lines beginning with %% !
  170.  
  171.     - The number of removed caracters and inserted ones must be the same.
  172.  
  173.     - I2DB has been created for Aminet Indexes. Other files won't work !
  174.  
  175. If you don't do that I2DB will react in a VERY strange way......
  176.  
  177.  
  178. History
  179. -------
  180.  
  181. August 1995             Version 1.0         First release
  182.  
  183.  
  184.  
  185. Tests
  186. -----
  187.  
  188. I2DB has been created and tested on an Amiga 1200 with a Blizzard 1220/4 expansion
  189. card. An index file of 1.3 MB is converted in about 16 seconds.
  190.  
  191.  
  192. Disclaimer
  193. ----------
  194.  
  195. I2DB has been tested on my machine (see tests) and you use it at your own risks.
  196. I can't be responsible for lost data due to its usage. With used algorithms it can't
  197. make damages.
  198.  
  199.  
  200. Distribution
  201. ------------
  202.  
  203. I2DB is GIFTWARE. If you like it and use it you can send me something, according
  204. to the value you give to I2DB (if you send me money please send me cash only).
  205.  
  206. I keep a copyright on this program. Public domain organisations and magazines
  207. are allowed to distribute it if the archive remains intact (don't hack I2DB) and
  208. if the price of the support is normal. France Festival Distribution WILL NEVER
  209. BE ALLOWED TO DISTRIBUTE THIS PROGRAM.
  210.  
  211.  
  212. Of course Aminet is allowed to distribute it and to put it on an Aminet CD ROM :-)
  213.  
  214.  
  215. Author
  216. ------
  217.  
  218.  
  219. I2DB has been created by :
  220.  
  221. Franck Aniere
  222. 30 Rue Jean Bouin
  223. 93220 GAGNY (France)
  224.  
  225. E-Mail : aniere@univ-mlv.fr
  226.  
  227. IRC    : nickname FSA on the channel #amigafr (sometimes #amiga)
  228.  
  229. You can join me for any suggestions, bug reports, enforcer hits (I have no MMU)
  230. or just to tell me what do you think of it.
  231.  
  232. If you find a bug or if I2DB doesn't work with your files contact me and and I'll
  233. fix the problem quickly. Instead of writting another program if mine doesn't work
  234. with you just tell me what do you want in it and I'll see if I add this feature.
  235.  
  236. By the way if you create cool external modules for I2DB please send them to me
  237. and I will include them in the next versions of I2DB (with your name of course).
  238.  
  239.  
  240. Thanks
  241. ------
  242.  
  243. Arne Meyer for AST, the greatest Aminet search tool (I use it everyday).
  244.  
  245. Amiga creators, for such a wonderful computer.
  246.  
  247.  
  248. To do
  249. -----
  250.  
  251. I wait for your suggestions..... ;-)